Skip to main content

CKYC Search and Download APIs

Overview

CKYC Search and Download APIs enable Regulated Entities (REs) to check whether a customer's KYC data exists in the CERSAI central repository and download it for verification and onboarding workflows.

Docker-based Deployment

For Search and Download operations, HyperVerge provides a Docker-based solution that packages the entire CKYC Search and Download system into a self-contained container that REs deploy on their own infrastructure.

This approach is required because CERSAI mandates that CKYC data must reside and move only within the RE's own infrastructure. Third-party service provider (TSP) infrastructure is disallowed, making fully local deployment a compliance requirement.

Why Docker:

  • CERSAI Compliance: CKYC data stays entirely within RE infrastructure — no data leaves the RE environment.
  • OTP Consent Support: Fully aligned with the OTP-based consent mandate introduced in CKYC v1.3.
  • Portability: Easy to deploy, audit, and scale within the RE's on-premises or cloud setup.
  • Consistency: The container behaves identically across test and production environments.

What's included:

ComponentDescription
Docker imageSelf-contained runtime with all CKYC Search and Download dependencies
CERSAI-compliant encryption and signingHandles request signing and encryption as per CERSAI specifications
Sample payloadsPre-built test payloads for UAT and integration testing before go-live
OTP consent flowBuilt-in support for the individual download OTP flow (CKYC v1.3)
Search-Only vs Search and Download

The Docker deployment supports two modes of operation:

  • Search-only: Returns a summary of the CKYC record (name, masked CKYC number, KYC date) without downloading the full record. Set returnOnlySearchResponse: yes in the request.
  • Search and Download (coupled): Performs both search and download in a single call. This is the default behaviour when an authentication factor (OTP for individuals, date of incorporation or other factor for legal entities) is provided.

APIs

The following APIs are available under the CKYC Search and Download suite:

API NameDescription
CKYC Individual Download Docker SolutionDocker-based setup for individual (OTP-based) CKYC record downloads, deployed on RE infrastructure.
CKYC Legal Entity Download Docker SolutionDocker-based setup for legal entity CKYC record downloads, deployed on RE infrastructure.
Was this helpful?
ON THIS PAGE
Ask AIBeta
Hi! How can I help?
Ask me anything about HyperVerge products, APIs, and SDKs.
Try asking: